home *** CD-ROM | disk | FTP | other *** search
/ Univers Interactif 3 / INTERACTIF.BIN / pc / planeten / internet / chat21pr.sit / Chat 2.1Pre10 Release / Chat Documentation < prev    next >
Text File  |  1995-03-07  |  12KB  |  361 lines
  1. NOTE: This documentation is really out of date, alot of commands are not
  2. described in here. Look at /HELP and \HELP while connected to the chat
  3. room for more information.
  4.  
  5. READ THE FAQ!
  6.  
  7. =========
  8. Contents:
  9. =========
  10.  
  11.     * What is Chat?
  12.     * Shareware Fees/Information:
  13.     * Where can I get the latest version:
  14.     * Restrictions/Requirements/Fine Print/Etc.
  15.     * What is needed to run Chat?
  16.     * How do I connect to Chat?
  17.     * User Command Summary:
  18.     * Administrator Command Summary:
  19.     * Customizing Chat:
  20.     * Configuring the IP Filter Option
  21.     * About the Author:
  22.     * Acknowlegments:
  23.  
  24.   Enclosed files:
  25.     * Sample Session - Sample Login and Use of the Chat Room
  26.     * Chat Release Information - Information about each version
  27.     * Chat FAQ - Frequently Asked Questions
  28.  
  29. =============
  30. What is Chat?
  31. =============
  32.  
  33. Chat is a application that lets a Macintosh with MacTCP serve as a
  34. simple internet chat room.  Once Chat is running on your mac, multiple
  35. people can Telnet to your mac and have online discussions.
  36.  
  37. The user portion of Chat has no macintosh user interface, the only way
  38. to use it is by telneting to your mac. However, the adminstrator can
  39. perform most of the tasks necessary through the macintosh interface.
  40.  
  41. Chat can support as many connections as it has memory for - and MacTCP
  42. will allow.
  43.  
  44. ===========================
  45. Shareware Fees/Information:
  46. ===========================
  47.  
  48. Chat is what is Shareware ($10 per machine for up to 5 machines). This
  49. only applies to  the machine that chat is actually running on, you can
  50. have as many connections as you want. (The more the better!) If you are
  51. a student or something, and  legitimately cannot afford to send me the
  52. shareware fee, send me a Postcard from your home/college/current town
  53. instead.
  54.  
  55. The site license, if you want to run chat on multiple machines is $50.
  56.  
  57. If you work for a software company, and cannot/do not want to pay the
  58. shareware fee, I would accept a sample copy of a product that you
  59. produce.
  60.  
  61. I would appreciate at the very least an email message from anyone who
  62. uses chat, or has done anything interesting with the source.
  63.  
  64. See "About the Author" for Email Address and Postal Address.
  65.  
  66.  
  67. ===================================
  68. Where can I get the latest version:
  69. ===================================
  70.  
  71. Chat can be ftp'd from most of the major archive sites, include any
  72. Info-Mac mirror. You can also always get the latest version from
  73. pluto.cc.umr.edu in the /pub/chat directory. The source to Chat is
  74. available in that directory as well.
  75.  
  76. For World Wide Web users, the chat home page is:
  77.     http://pluto.cc.umr.edu/chat.html
  78.  
  79.  
  80. =========================================
  81. Restrictions/Requirements/Fine Print/Etc.
  82. =========================================
  83.  
  84. The Chat application may be uploaded to any online service, provided
  85. that the entire archive is uploaded and no changes are made to it. The
  86. source to Chat may not be uploaded to any other FTP site or to any
  87. online service without contacting me first, currently the only place
  88. you can get the source is from my ftp site (pluto.cc.umr.edu).
  89.  
  90. If you want to include chat on any mass distribution medium, such as a
  91. CD-Rom, or want to include it with any other applications distributed
  92. with a book for example; contact me first, I will make sure that you
  93. have the latest version. In addition, I would appreciated, though I do
  94. not require, a sample copy of the CD/book/etc.
  95.  
  96. If you want to redistribute the source to chat with Changes or as a new
  97. program, please contact me via email first. I would like to take a look
  98. at the application. Also, any redistributed application or source must
  99. aknowledge both me, and Peter Lewis in the source, and the About Box.
  100.  
  101. ===========================
  102. What is needed to run Chat?
  103. ===========================
  104.  
  105. You must have MacTCP 1.1 or newer to run Chat.
  106.  
  107. Currently, as of version 2.1, Chat requires System 7. If there is
  108. interest in maintaining support for System 6, I will put that support
  109. in. Email me if you want this done.
  110.  
  111. Due to constraints imposed by MacTCP, chat is currently limited to 18
  112. users online simultaneously.
  113.  
  114.  
  115. =========================
  116. How do I connect to Chat?
  117. =========================
  118.  
  119. To connect to the chat room, you need a program which supports telnet
  120. connections.
  121.  
  122. Programs which support telnet connections:
  123.  
  124. The default PORT number for chat as distributed is 23 - the default
  125. telnet port. So, when connecting to the chat room with telnet or
  126. another application, you do not need to specify a port number, or if
  127. you do specify one, it should be 23.
  128.  
  129. Mac:
  130.    NCSA Telnet   -   Open Connection in File Menu
  131.    MUDDweller    -   New, TCP/IP Address in Config Menu, Open Connection
  132.  
  133. Unix:
  134.    Telnet        -   'telnet address' or 'telnet address port'
  135.  
  136. VMS:
  137.    Telnet        -   'telnet address' or 'telnet address /port=port'
  138.  
  139. Once you are connected, simply fill in the requested information on
  140. screen. After the initial login screen, anything you type will be sent
  141. to the screen. If you type a line that begins with "/" or "\", it will
  142. be treated as a user or administrator command, respectively.
  143.  
  144. Both user commands and administrator commands are documented next.
  145.  
  146.  
  147. =====================
  148. User Command Summary:
  149. =====================
  150.  
  151. The long form of the command name is listed here, see /HELP in the Chat
  152. room for information on the abbreviated/short forms.
  153.  
  154. COMMAND:
  155.   Usage                       What it does
  156.  
  157. ?:
  158.   /?                          Displays list of user commands
  159.  
  160. HELP:
  161.   /HELP                       Displays user command help
  162.  
  163. ABOUT:
  164.   /ABOUT                      Display info about the chat room.
  165.  
  166. ME:
  167.   /ME                         Displays information about yourself
  168.  
  169. QUIT:
  170.   /QUIT                       Exits the chat room.
  171.  
  172. LIST:
  173.   /LIST                       Lists users on current channel
  174.  
  175. LISTALL:
  176.   /LISTALL                    Lists users on all channels
  177.  
  178. DO:
  179.   /DO text                    Sends text as an action.
  180.  
  181. YELL:
  182.   /YELL text                  Sends text to all channels.
  183.  
  184. PAGE:
  185.   /PAGE user                  Pages 'user' to current channel.
  186.  
  187. CHANNEL:
  188.   /CHANNEL                    Lists available channels.
  189.   /CHANNEL channel            Changes to channel 'channel'.
  190.  
  191. WHISPER:
  192.   /WHISPER user text          Sends 'text' to user 'user' only.
  193.  
  194. MSG:
  195.   /MSG                        Shows messages on the message board
  196.   /MSG text                   Adds a message to the message board
  197.  
  198. INFO:
  199.   /INFO                       Displays info about logins, users, etc.
  200.   
  201. SHOW:
  202.   /SHOW                       Shows current settings of user variables
  203.  
  204. CLEAR:
  205.   /CLEAR                      Clears screen with blank lines
  206.  
  207. SET:
  208.   /SET                        Lists available user variables.
  209.   /SET var value              Sets value of variable 'var' to 'value'
  210.   /SET NAME name              Changes your name to 'name'.
  211.   /SET SUBJECT text           Changes the subject of this channel
  212.   /SET ECHO on/off            Sets whether you see your own messages.
  213.   /SET AWAY on/off            Sets whether you are away from terminal
  214.   /SET AWAYMSG text           Sets msg to be displayed when away
  215.   /SET USERINFO text          Sets msg to be displayed when not away
  216.   /SET IGNORE name            Sets a user to ignore msgs from
  217.   /SET ANNOUNCE on/off        Sets whether you want to see announcements
  218.  
  219. RECENT:
  220.   /RECENT                     Lists recent users of the chat room
  221.  
  222. ROLL:      Roll some dice
  223.   /ROLL #d%                   Rolls #, % sided dice.
  224.   /ROLL                       Rolls one twenty sided die.
  225.  
  226.  
  227. ==============================
  228. Administrator Command Summary:
  229. ==============================
  230.  
  231. In all the following commands, 'pw' is the adminstrators password. The
  232. chat room will display admin command help if the password is incorrect
  233. or missing. The default administrator password is 'admin'.
  234.  
  235. ?:
  236.   \?                       Displays list of admin commands
  237.  
  238. HELP:
  239.   \HELP pw                 Displays administrative command help
  240.  
  241. KILL:
  242.   \KILL pw user            Kicks a user out of the chat room.
  243.  
  244. QUITNOW:
  245.   \QUITNOW pw              Quits the chat room application.
  246.  
  247. RESTART:
  248.   \RESTART pw              Kicks everyone off chat room, and restarts.
  249.  
  250. HIDE:
  251.   \HIDE pw                 Hide from /LIST and /LISTALL
  252.  
  253. UNHIDE:
  254.   \UNHIDE pw               Show yourself in /LIST and /LISTALL
  255.  
  256. LISTALL:
  257.   \LISTALL pw              Lists all users, include hidden ones.
  258.  
  259. GAG:
  260.   \GAG pw user             Silences a user
  261.  
  262. UNGAG:
  263.   \UNGAG pw user           Allows a user to speak again
  264.  
  265. SHOW:
  266.   \SHOW pw                 Displays current admin variable settings
  267.  
  268. INFO:
  269.   \INFO pw                 Displays information on chat room status
  270.  
  271. SET:
  272.   \SET pw var value        Sets the value of an administrator variable.
  273.   \SET pw                  Lists administrative variables.
  274.   \SET pw LOGINS On/Off    Allow user logins
  275.   \SET pw YELLS On/Off     Allow /YELL command
  276.   \SET pw WHISPERS On/Off  Allow /WHISPER command
  277.   \SET pw PASSWORDS On/Off Require password at login
  278.   \SET pw BEEP On/Off      Beep on Login
  279.   \SET pw PROMPT On/Off    Prompt for channel at login
  280.   \SET pw SUBJECT text     Set subject of current channel
  281.   \SET pw USERSUB On/Off   Allow users to change subjects
  282.  
  283. =====================
  284. Customizing Chat:
  285. =====================
  286.  
  287. Almost all of the strings and settings for chat are stored in the
  288. resource fork.
  289.  
  290. The strings can be edited to suit your particular environment, however,
  291. do not add or remove any strings, as the program will not be able to
  292. find them. The only exception to this are the Chat Log Filenames, Chat
  293. Channels, Chat Channel Subjects, User Passwords, and Admin Passwords
  294. string resources, you can add to these to add more channels, etc.
  295. Remember to add to all three channel string resources at the same time
  296. (Log File, Channel Name, and Subject).
  297.  
  298. The 'CPrf' resource holds the default preferences for the Chat Room.
  299.  
  300.  
  301. =================================
  302. Configuring the IP Filter Option:
  303. =================================
  304.  
  305. There are two STR# resources in the application that deal with IP 
  306. filtering. They are labelled Allow and Deny. Here is how they work:
  307.  
  308. All address are assumed to be allowed from the start
  309. If a match is found in the Deny list, the connection is denied unless
  310. a match is also found in the Allow list. This is so you can do stuff like:
  311.  
  312. Deny: 10.20.30.*
  313. Allow: 10.20.30.40
  314.  
  315. To deny all hosts in network 10.20.30, but allow one of those hosts to connect, 10.20.30.40.
  316.  
  317. You can only put IP addresses in the lists, no host names. The '*' is
  318. a wildcard and matches all values of that field.
  319.  
  320. I am not going to going into much more detail about how to use it, this
  321. should be enough.
  322.  
  323. =================
  324. About the Author:
  325. =================
  326.  
  327. I am a Computer Science major at the University of Missouri - Rolla,
  328. originally from Connecticut. I ran across chat while looking at TCP/IP
  329. applications for the Mac, and decided to customize it for my own
  330. purposes. It has evolved greatly since then, and is used by people all
  331. across the world.
  332.  
  333. I can be reached via email on the internet at "nneul@umr.edu".
  334.  
  335. My postal address:
  336.  
  337. Nathan Neulinger
  338. 53 Sleepy Hollow Lane
  339. Stamford, CT  06907-1734
  340. USA
  341.  
  342. ===============
  343. Acknowlegments:
  344. ===============
  345.  
  346. Thanks to Peter Lewis (peter.lewis@info.curtin.edu.au) for the original
  347. (1.1) version of Chat, and for much help in getting Chat to where it is
  348. today.
  349.  
  350. Thanks to Erich for the new and improved die rolling routines. For
  351. those who are interested, take a look at his re-release of chat, called
  352. NetRPG, for playing Role Playing Games over the internet.
  353.  
  354. Thanks to Jon Stevens (root@dolphin.csudh.edu) for extensive testing,
  355. and comments on how to improve chat.
  356.  
  357. Thanks to everyone who has written me about Chat with comments,
  358. suggestions, and anything else for that matter. It is your suggestions
  359. and wishes that have given me the directions for how to improve chat.
  360. Keep 'em coming.
  361.